Получение списка автомобилей

Запрос позволяет получить список зарегистрированных автомобилей клиента с возможностью фильтрации по пользователю и другими параметрами. Поддерживает постраничную навигацию и опцию включения удаленных машин.

Синтаксис запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/vehicles/list?order_id=<идентификатор заказа>
&limit=<количество записей> 
&cursor=<отметка от предыдущего запроса>
&user_id=<идентификатор пользователя>
&include_deleted=false

Заголовки запроса

• Authorization: Bearer <OAuth-токен>
  Процесс получения токена описан в разделе Начало работы.

• X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

• order_id — идентификатор клиента.

Запрос может содержать следующие необязательные параметры:

• limit — количество выводимых записей. При отсутствии данного параметра возвращается информация о первых 100 записях.
• cursor — отметка запроса (возвращается в теле ответа на предыдущий запрос). Для запроса первой страницы параметр указывать не нужно, для запросов последующих страниц — обязательно.
• user_id — идентификатор пользователя (для фильтрации).
• include_deleted — включать удаленные (архивированные) автомобили. По умолчанию false.

Описание полей ответа

Ответ возвращается в формате JSON и содержит постраничный список автомобилей.

Пример запроса

GET https://b2b-api.go.yandex.ru/integration/2.0/vehicles/list?client_id=client-001&limit=10&include_deleted=false
Authorization: Bearer <OAuth-токен>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

"items": [
  {
    "vehicle_id": "7ea0b....75e9",
    "license_plate": "М200ММ199",
    "model": "Газель Next",
    "limit": {
        "limit_id": "7715b673f2....39c9b0d4b6",
        "service": "tanker",
        "title": "Ежедневные лимиты",
        "fuel_types": [
            "metan"
        ],
        "limits": {
            "orders_cost": {
                "value": "1000",
                "period": "month",
                "kind": "money"
            }
        }
    },
    "created_at": "2022-11-21T14:36:27.369997+00:00",
    "access_type": "custom",
    "is_deleted": false,
    "drivers": {
        "total_count": 0,
        "users": [],
        "departments": []
    }
  }
]

Возможные коды ответа

• 200 — успешно
• 400 — ошибка параметров запроса
• 403 — доступ запрещён